Clarify --restart-recipes flag behavior and change default to false #25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The --restart-recipes flag allows restarting of running recipes that are updated during import, but does not force stopped recipes to restart. This was not clear from the help text and documentation. Changes: - Changed default from true to false (breaking change - more conservative) - Updated help text to clarify that stopped recipes remain stopped - Added inline comments in documentation to explain behavior - Updated test to reflect new default value Users who want to allow recipe restarts must now explicitly use: workato push --restart-recipes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR changes the default behavior of the --restart-recipes flag in the push command from True to False, making recipe restart an opt-in feature rather than opt-out. The help text is also updated to clarify that the flag only allows restarting of running recipes that were updated, while stopped recipes remain stopped.
Key Changes
- Changed
--restart-recipesdefault fromTruetoFalsein the push command - Updated help text to clarify that the flag allows restarting running recipes, and stopped recipes remain stopped
- Updated test expectations to align with the new default value
- Updated documentation to reflect the new default behavior and add clarifying comments
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/workato_platform_cli/cli/commands/push/command.py |
Changed --restart-recipes default to False and updated help text to clarify behavior |
tests/unit/commands/push/test_command.py |
Updated test assertion to expect False as default value for restart_recipes |
docs/USE_CASES.md |
Added comments clarifying that --restart-recipes only restarts running recipes |
docs/COMMAND_REFERENCE.md |
Updated documentation to note recipes won't restart by default and clarified behavior; fixed trailing whitespace |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The
--restart-recipesflag allows restarting of running recipes that are updated during import, but does not force stopped recipes to restart. This was not clear from the help text and documentation, leading to confusion about the expected behavior.Changes
truetofalse(more conservative approach)Behavior
Before:
workato pushwould allow recipe restarts by defaultAfter:
workato pushwill NOT allow recipe restarts by defaultUsers who want to allow restarts must now explicitly use:
This aligns with the Workato API's default behavior and makes the CLI more conservative by default.
Testing
🤖 Generated with Claude Code